Add "Choosing a collection" section to README - #68
Merged
Conversation
Adds a decision table mapping common workloads onto the right Celerity collection, a short note on hasher selection, and an honest list of cases where Celerity is not the right answer today (concurrent access, mutable IDictionary<,> consumers, FrozenDictionary-style build-once lookups). Implements the "Document when to use which collection" sub-task from issue #15. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README.md, between Quick start and Benchmarks. It contains a decision table mapping common workloads (int-keyed,long-keyed,Guid/string/ other-keyed dictionaries, the two set shapes) onto the right Celerity type, a short note on picking a hasher (deferring to the existing matrix indocs/api/hashing.md), and a candid list of cases where Celerity is not the right answer today: concurrent access, mutableIDictionary<,>consumers, andFrozenDictionary-style build-once string-keyed lookups (the Celerity equivalent is on the 1.2.0 roadmap, #62).[Unreleased]entry toCHANGELOG.md.This implements the "Document when to use which collection" sub-task from issue #15. Issue #15 has several other sub-tasks still open (perf-tuning guide, migration guide, troubleshooting, FAQ), so the issue itself stays open.
Doc-only change — no source under
src/Celerity/was touched.Test plan
cd src && dotnet build— 0 errors (warnings are pre-existing xUnit lint nits, unchanged by this PR).